home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is the Mozilla SVG project.
- *
- * The Initial Developer of the Original Code is
- * Crocodile Clips Ltd.
- * Portions created by the Initial Developer are Copyright (C) 2002
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Alex Fritze <alex.fritze@crocodile-clips.com> (original author)
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
-
- interface nsISVGRendererRegion;
- interface nsISVGRendererGlyphMetrics;
- interface nsISVGRendererCanvas;
-
- /**
- * \addtogroup renderer_interfaces Rendering Engine Interfaces
- * @{
- */
-
- /**
- * One of a number of interfaces (all starting with nsISVGRenderer*)
- * to be implemented by an SVG rendering engine. See nsISVGRenderer
- * for more details.
- *
- * The SVG rendering backend uses this interface to communicate to the
- * rendering engine-native glyph objects.
- *
- * A glyph object is instantiated by the rendering backend for a given
- * nsISVGGlyphGeometrySource object with a call to
- * nsISVGRenderer::createGlyphGeometry(). The glyph object is assumed
- * to store a reference to its associated source object and provide
- * glyph rendering and hit-testing for the (composite) glyph described
- * by the nsISVGGlyphGeometrySource members.
- */
- [scriptable, uuid(cd302675-b093-4018-8081-3e65af962aa8)]
- interface nsISVGRendererGlyphGeometry : nsISupports
- {
- /**
- * Paint this object.
- *
- * @param canvas The canvas to render to.
- */
- void render(in nsISVGRendererCanvas canvas);
-
- /**
- * Called by this object's corresponding nsISVGGlyphGeometrySource
- * as a notification that some of the source's data (identified by
- * paramter 'updatemask') has changed.
- *
- * @param updatemask An OR-ed combination of the UPDATEMASK_*
- * constants defined in nsISVGGlyphGeometrySource.
- * @return Region that needs to be redrawn.
- */
- nsISVGRendererRegion update(in unsigned long updatemask);
-
- /**
- * Get a region object describing the area covered with paint by
- * this glyph geometry.
- *
- * @return Covered region.
- */
- nsISVGRendererRegion getCoveredRegion();
-
- /**
- * Hit-testing method. Does this glyph geometry (with all relevant
- * transformations applied) contain the point x,y? Should work on a
- * character-cell basis, rather than the actual character outline.
- *
- * @param x X-coordinate of test point. @param y Y-coordinate of
- * test point.
- * @return PR_TRUE if the glyph geometry contains the point,
- * PR_FALSE otherwise.
- */
- boolean containsPoint(in float x, in float y);
- };
-
- /** @} */
-